01 May 2025

Configure ePayments

Configure ePayments to enable institutions to facilitate the payment of fees for courses in ebs. You can integrate ebs with various payment providers, such as Flywire, Paysafe, and so on. For more information on the payment providers supported by ebs, go to Payment Providers.

Before configuring ePayments note the following prerequisites:

  • You must have an ebs account with administrative permissions for ebs: central and ebs: ontrack Hub.
  • You must have access to the relevant payment provider for the institution.
  • The institution must have the appropriate licences. That is, AdvanceEPayments, EPayments, or LearnerEPayments.

Configure ePayments as follows:

  1. Define the institution settings for Ontrack Learner and ePayments (Common)

  2. Define the reference data for ePayment Transaction Status Codes and Payment Methods

  3. Ensure the ePayment Callback and Payment URLs are publicly accessible

  4. Set up the institution's chosen payment provider

  5. Test the ePayment integration

Institution Settings

Define the relevant institution settings for Ontrack Learner and ePayments (Common). On ebs: central, go to Institution Settings and then define the following settings.

The ePayments (Staff) and ePayments (Self-Service) institution settings are also applicable but need to be configured differently for each payment provider.

ePayments Reference Data

Define the reference data for ePayment Transaction Status Codes and Payment Methods. On ebs: central, go to Reference Data and then define the following reference data.

ePayment Callback and Payment URLs

The integration with Flywire does not use the ePayment Callback and Payment URLs. Therefore, this step is not required for institutions using Flywire.

Two standard URLs are used to make payments and receive payment responses from all third-party payment providers, apart from Flywire.

The following URLs must be publicly accessible:

  • Payment responses are received with <web service URL>/EPayments/PaymentResponse.aspx.
  • Payments are initiated by <web service URL>/EPayments/MakePayment.aspx.

Firewall changes may be required to make .aspx pages publicly accessible.

Set up the payment provider

The settings and information required to set up the institution's chosen payment provider differs for each payment provider. The settings are mostly defined in the institution settings for ePayments (Staff) and ePayments (Self-Service). The settings required for each payment provider are as follows:

Test ePayment Integration

After configuring the payment provider, you can test your ePayment integration by setting up a one-off fee for a learner and then process the payment as a staff member on behalf of the learner or process a learner self-service payment.